home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dskut / xtrv1.zip / XTRACT.DOC < prev    next >
Text File  |  1993-01-05  |  11KB  |  330 lines
  1.  
  2.  
  3.                      XTRACT data extraction and reformatting.
  4.                      Copyright 1991 by A.P.Cunningham
  5.                      Shareware Version 1.0 July 1922
  6.  
  7.  
  8.   This program bas created to save the frequently laborious
  9. task of converting data from one format to another as is often
  10. the case when moving data between different applications. 
  11. Xtract makes it easy for you to specify how a text file should
  12. be reformatted into the form that you need for input into a
  13. spreadsheet, database or stats package. 
  14.  
  15.   XTRACT is simple to use and has been designed to minimise
  16. the number of keystrokes needed to specify how the data is to
  17. be reformatted.  Because XTRACT uses a visual marking system,
  18. you don't need to calculate where fields begin and end in the
  19. input document.  XTRACT takes note of the order you choose
  20. when you mark fields and you can use this facility to  control
  21. the sequence of data in your output file.  For example, XTRACT
  22. makes short work of changing date formats from US to UK.
  23.  
  24.     XTRACT keeps a record of the fields you have marked by
  25. saving a template in a separate file.  You can edit this
  26. template later or re-use it unchanged to extract data from
  27. sets of similarly formatted documents.
  28.  
  29.  
  30.   Demonstration:
  31.  
  32.        First unpack the software into a directory (using the
  33.      program PKUNZIP) by typing:-     
  34.                                    PKUNZIP XTRACT
  35.  
  36.        Next type:-  DEMO
  37.  
  38.      This will start XTRACT using a data file called TEMP.DAT
  39.  
  40.        When you have looked at the screen, try pressing the
  41.      tab key a few times - the cursor should move between the
  42.      fields in the order they were marked.  Then press the F2
  43.      key and the program will finish and create a file called
  44.      TEST.XTR.
  45.  
  46.        Use a file browser or text editor to look at the files
  47.      TEST.DAT & TEST.XTR and see how the data has been
  48.      reformatted.
  49.   
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.   Starting  XTRACT:
  60.  
  61.        You start by typing the program name XTRACT followed by
  62.      the file name of your input document eg:-
  63.  
  64.                XTRACT mydoc.dat
  65.  
  66.      Note:  If you type the filename without its extension,
  67.      then XTRACT will assume that the extension is .dat. 
  68.  
  69.  
  70.   Creating the template:
  71.  
  72.        When you start XTRACT, part of the first page of your
  73.      document is displayed on the screen.  You can see more of
  74.      the document by using the Page-Up & Page-Down keys.  If
  75.      the document is wider then the screen, then use <Ctrl>
  76.      plus Right or Left arrow keys to scroll sideways.
  77.  
  78.        You start creating the template by using the arrow keys
  79.      to move the cursor to the beginning of the first field. 
  80.      You then use the space bar to 'over-type' the field area
  81.      which will change to a different colour.  
  82.  
  83.        Should you need to distinguish between text and numeric
  84.      fields, you can indicate a text field by pressing the "
  85.      key whilst the cursor is located in the field.
  86.  
  87.        If the application's input needs a comma, colon or /
  88.      between the fields, then type the appropriate symbol
  89.      whilst the cursor is in the marked field.  If you omit
  90.      the symbol, then the separator will be a space.  If you
  91.      wish to join this field onto another area in a different
  92.      part of the document, then you must type in a + in place
  93.      of the separator symbol.
  94.  
  95.        You can now move on to the next area by using the
  96.      standard cursor movement keys and mark the field as
  97.      before.  Continue to do this until you have completed
  98.      marking just the first page of the document.  Then move
  99.      to the end of the first page and type * to indicate the
  100.      page break.
  101.  
  102.        If you wish to separate a continuous area into two or
  103.      more distinct fields, then use the \ key in place of the
  104.      space bar to mark the first position in the next field
  105.      and use the space bar to highlight the remainder of the
  106.      field.  The \ will not be printed and the colour will
  107.      change to indicate that you are marking a new  area.  If
  108.      you have already typed in a separator symbol at the end
  109.      of the first field, don't worry, just type the \ on top. 
  110.  
  111.        If you have been too enthusiastic in marking an area
  112.      and made the field too big, then use the Delete key to
  113.      reduce the size or erase the marking altogether.   
  114.  
  115.  
  116.  
  117.        Where there are tables in your document, you need only
  118.      mark up the first row of the table.  When you have done
  119.      this press the F3 key to flag this line.  Next move to
  120.      the bottom of the table and press the F5 key, you will
  121.      see all the intervening lines become marked up in the
  122.      same way as the flagged line.  When the lines are not
  123.      next to each other, you will need to use the F4 key to
  124.      copy the markings from the flagged line.
  125.  
  126.        If you wish to be reminded of the order in which you
  127.      created the marked areas, just press the tab key to move
  128.      between fields.
  129.  
  130.        Before you finish, check that you have marked the last
  131.      line in the first page of your document with the * key. 
  132.      Should you mark the wrong line, then you will find that
  133.      subsequent pages of the input file will be incorrectly
  134.      reformatted.  
  135.  
  136.        You can start the formatting process, by pressing the
  137.      F2 key.  When this operation has been completed, XTRACT
  138.      will terminate placing the results in a file with the
  139.      0extension .xtr and save the template to a file with the
  140.      extension .fld.  If your input file was mydoc.dat then
  141.      the output file will be mydoc.xtr and the template file
  142.      will be mydoc.fld. 
  143.  
  144.        There are two other ways you can exit from XTRACT, Esc
  145.      exits immediately saving nothing and F7 just saves the
  146.      template but does not create a reformatted output file.
  147.  
  148.        You can correct any mistakes in formatting by re-
  149.      running XTRACT and editing the template.  You can also
  150.      try using an editor to alter the template file, and then
  151.      run XTRACT to check the alignment of the marked areas.
  152.  
  153.  
  154.    Quick Reference
  155.  
  156.  Start-up: 
  157.  
  158.      Just type:-
  159.  
  160.                 XTRACT filename
  161.  
  162.   Note:    1. The default extension of the input file is .dat
  163.            2. The output file extension will be .xtr
  164.            3. The template file extension will be .fld
  165.  
  166.  
  167.  Marking fields:
  168.  
  169.         When the document appears use the space bar to mark
  170.      the fields and the cursor keys to move between fields. 
  171.      For wide documents, use Ctrl + arrow keys (-> & <-) to
  172.      scroll right and left.  The help key (F1) summarises the
  173.      main keys.
  174.  
  175.  
  176.  Joining areas:
  177.  
  178.         After marking the first area, type a + symbol at then.
  179.      Then move to the next area and mark it.  If there are any
  180.      mor areas to join, continue the process of adding a + and
  181.      marking the next area.  The areas will be joined in the
  182.      order of marking.
  183.  
  184.  
  185.  Reviewing order of marking:
  186.  
  187.         If you press the tab key, the cursor will step from
  188.      one marked area to the next in the same order that the
  189.      areas were marked.
  190.  
  191.  
  192.  Splitting joined fields:
  193.  
  194.         Where one field runs into the next, use the \ symbol
  195.      to mark the beginning of the next field.  Use the space
  196.      bar to mark the remainder of the field's area. You will
  197.      see the next area highlighted in a different colour.
  198.  
  199.  
  200.  Specifying separators:
  201.  
  202.         You can specify a field separator by typing a valid
  203.      symbol at the end of a marked area.  The valid symbols
  204.      are:- ,./:  plus the return key, which splits the output
  205.      into more then one line.   
  206.  
  207.  
  208.  Specifying text field:
  209.  
  210.        Place the cursor within the highlighted area and press
  211.      the " key.
  212.  
  213.  
  214.  Duplicating marked areas:
  215.  
  216.         To duplicate a line containing fields already marked,
  217.      press F3 (with the cursor in the line) to flag the line. 
  218.      Move the cursor to another line below; now when you press
  219.      F4, the marked areas of the flagged line will be copied. 
  220.      If you press F5 instead of F4, then all the intervening
  221.      lines will be mark